Make termination condition config declarative #4984

victordibia · 2025-01-10T05:59:59Z

Why are these changes needed?

Step 1 in making components in agentchat natively declarative.

from autogen_agentchat.conditions import StopMessageTermination, MaxMessageTermination 

max_term = MaxMessageTermination(5)
stop_term = StopMessageTermination() 

or_term = max_term | stop_term
print(or_term.dump_component() )
 
print(max_term.dump_component())

Results

ComponentModel(provider='autogen_agentchat.base._termination._OrTerminationCondition', 
component_type='termination', version=1, component_version=1, description=None, 
config={'conditions': [{'provider': 'autogen_agentchat.conditions.MaxMessageTermination', '
component_type': 'termination', 'version': 1, 'component_version': 1, 
'config': {'max_messages': 5}}, {'provider': 'autogen_agentchat.conditions.StopMessageTermination', 
'component_type': 'termination', 'version': 1, 'component_version': 1, 'config': {}}]})

ComponentModel(provider='autogen_agentchat.conditions.MaxMessageTermination', 
component_type='termination', version=1, component_version=1, 
description=None, config={'max_messages': 5})

Related issue number

Closes #4983

Checks

I've included any doc changes needed for https://microsoft.github.io/autogen/. See https://microsoft.github.io/autogen/docs/Contribute#documentation to build and test documentation locally.
I've added tests (if relevant) corresponding to the changes introduced in this PR.
I've made sure all auto checks have passed.

codecov · 2025-01-10T06:03:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.05%. Comparing base (6bc285c) to head (489db97).
Report is 2 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #4984       +/-   ##
===========================================
- Coverage   72.42%   56.05%   -16.37%     
===========================================
  Files         112       67       -45     
  Lines        6494     5755      -739     
===========================================
- Hits         4703     3226     -1477     
- Misses       1791     2529      +738

Flag	Coverage Δ
unittests	`56.05% <ø> (-16.37%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ekzhu · 2025-01-10T06:27:11Z

python/packages/autogen-agentchat/src/autogen_agentchat/base/_termination.py

+
+    component_config_schema = AndTerminationConditionConfig
+    component_type = "termination"
+


Shall we include component override for cleaner path?

Yes,

@ekzhu , for Or/AndTerm, are you fine with making it a public TerminationCondition and exporting this to give it a clean path? Anyway, these are used in developer code (or_term = stop_term and max_term) so might be a good idea?

Something like from ._termination import TerminatedException, TerminationCondition, OrTerminationCondition, AndTerminationCondition

ekzhu

Looks good! Just to make sure, we will use the override for a cleaner provider path right?

jackgerrits · 2025-01-10T14:29:55Z

python/packages/autogen-agentchat/src/autogen_agentchat/base/_termination.py



-class TerminationCondition(ABC):
+class TerminationCondition(ABC, Component[Any]):


Suggested change

class TerminationCondition(ABC, Component[Any]):

class TerminationCondition(ABC, Component[BaseModel]):

I was gonna ask about this ... it leads to a flurry of pyright/mypy errors .. was not sure how to deal :) . Given that each base class have their own ConfigModels ..

Also, ComponentLoader does not want an abstract class (TerminationCondition) and it will be too disruptive to make a concrete BaseTerminationCondition and then refactor the rest of the code to do this.

conditions = [ ComponentLoader.load_component( condition_model, TerminationCondition) for condition_model in config.conditions ]

I think the pattern should be that the base interface is a ComponentLoader but not a Component since itself is not loadable after all!

But this does make it difficult to generically dump a component...

Should be written as (after making the interface a ComponentLoader):

TerminationCondition.load_component(...)

Unsure if that fixes your issue though

make termination condition declarative

489db97

ekzhu reviewed Jan 10, 2025

View reviewed changes

jackgerrits reviewed Jan 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make termination condition config declarative #4984

Make termination condition config declarative #4984

victordibia commented Jan 10, 2025

codecov bot commented Jan 10, 2025 •

edited

Loading

ekzhu Jan 10, 2025

victordibia Jan 10, 2025 •

edited

Loading

ekzhu left a comment

jackgerrits Jan 10, 2025

victordibia Jan 10, 2025 •

edited

Loading

jackgerrits Jan 10, 2025 •

edited

Loading


		component_config_schema = AndTerminationConditionConfig
		component_type = "termination"



		class TerminationCondition(ABC):
		class TerminationCondition(ABC, Component[Any]):

Make termination condition config declarative #4984

Are you sure you want to change the base?

Make termination condition config declarative #4984

Conversation

victordibia commented Jan 10, 2025

Why are these changes needed?

Related issue number

Checks

codecov bot commented Jan 10, 2025 • edited Loading

Codecov Report

ekzhu Jan 10, 2025

Choose a reason for hiding this comment

victordibia Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

ekzhu left a comment

Choose a reason for hiding this comment

jackgerrits Jan 10, 2025

Choose a reason for hiding this comment

victordibia Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

jackgerrits Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 10, 2025 •

edited

Loading

victordibia Jan 10, 2025 •

edited

Loading

victordibia Jan 10, 2025 •

edited

Loading

jackgerrits Jan 10, 2025 •

edited

Loading